Skip Headers

Oracle® Database XML C++ API Reference 10g Release 2 (10.2) Part Number B16206-01 |
Home | Book List | Contents | Index | Master Index | Feedback

Previous | Next
| View PDF

# 4 Package OracleXml APIs for C++

OracleXml is the namespace for all XML C++ interaces. It includes class `XmlException`, the root for all exceptions in XML, and these namespaces:

- Ctx - namespace for TCtx related declarations, described in Chapter 1, "Package Ctx APIs for C++"

- Dom - namespace for DOM related declarations, described in Chapter 2, "Package Dom APIs for C++"

- IO - namespace for input and output source declarations, described in Chapter 3, "Package IO APIs for C++"

- Parser - namespace for parser and schema validator declarations, described in Chapter 5, "Package Parser APIs for C++"

- SOAP - namespace for the Simple Object Access Protocol declarations, described in Chapter 6, "Package SOAP APIs for C++"

- Tools - namespace for Tools::Factory related declarations, described in Chapter 7, "Package Tools APIs for C++"

- XPath - namespace for XPath related declarations, described in Chapter 8, "Package XPath APIs for C++"

- XPointer - namespace for XPointer related declarations, described in Chapter 9, "Package XPointer APIs for C++"

- Xsl - namespace for XSLT related declarations, described in Chapter 10, "Package Xsl APIs for C++"

This chapter contains this section:

- XmlException Interface

See Also: Oracle XML Developer's Kit Programmer's Guide Oracle XML DB Developer's Guide

## XmlException Interface

`XMLException` is the root interface for all XML exceptions. Table 4-1 summarizes the methods of available through the `OracleXml` Package.

Table 4-1 Summary of OracleXml Package Interfaces

Function | Summary
--- | ---
getCode() | Get Oracle XML error code embedded in the exception.
getMesLang() | Get current language (encoding) of error messages.
getMessage() | Get Oracle XML error message.

### getCode()

This is a virtual member function that defines a prototype for implementation defined functions returning Oracle XML error codes (like error codes defined in xml.h) of the exceptional situations during execution

Syntax

    virtual unsigned getCode() const = 0;

Returns

`(unsigned)` numeric error code (0 on success)

### getMesLang()

This is a virtual member function that defines a prototype for user defined functions returning current language (encoding) of error messages for the exceptional situations during execution

Syntax

    virtual oratext* getMesLang() const = 0;

Returns

`(oratext *)` Current language (encoding) of error messages

### getMessage()

This is a virtual member function that defines a prototype for implementation defined functions returning Oracle XML error messages of the exceptional situations during execution.

Syntax

    virtual oratext* getMessage() const = 0;

Returns

`(oratext *)` Error message